hmkit-fleet/com.highmobility.hmkitfleet/[js]HMKitFleet

HMKitFleet

class HMKitFleet(configuration: String, environment: Environment, hmKitConfiguration: HMKitConfiguration = HMKitConfiguration.defaultConfiguration())

HMKitFleet is the access point for the Fleet SDK functionality. It is accessed by creating a new HMKitFleet object with a service account private key JSON string.

HMKitFleet fleet = new HMKitFleet(
    readStringContents(service-account-private-key-{id}.json),
    HMKitFleet.Environment.SANDBOX
);

Constructors

HMKitFleet

constructor(configuration: String, environment: Environment, hmKitConfiguration: HMKitConfiguration = HMKitConfiguration.defaultConfiguration())

Functions

deleteClearance

fun deleteClearance(vin: String): Promise<Nothing>

Delete the clearance for the given VIN.

getClearanceStatus

fun getClearanceStatus(vin: String): Promise<Response<ClearanceStatus>>

Get the status of a vin that has previously been registered for data access clearance with requestClearance. After the vin is Approved, getVehicleAccess and subsequent sendCommand can be sent.

getClearanceStatuses

fun getClearanceStatuses(): Promise<Response<List<ClearanceStatus>>>

Get the status of VINs that have previously been registered for data access clearance with requestClearance. After VIN is Approved, getVehicleAccess and subsequent sendCommand can be sent.

getEligibility

fun getEligibility(vin: String, brand: Brand): Any

Get the eligibility status for a specific VIN. This can be used to find out if the vehicle has the necessary connectivity to transmit data.

getVehicleState

fun getVehicleState(vin: String): Promise<Response<String>>

requestClearance

fun requestClearance(vin: String, brand: Brand, controlMeasures: List<ControlMeasure>? = null): Promise<Response<RequestClearanceResponse>>

Start the data access clearance process for a vehicle.